<!DOCTYPE html>

<html :class="{'dark': darkMode === 'dark' || (darkMode === 'system' &amp;&amp; window.matchMedia('(prefers-color-scheme: dark)').matches)}" class="scroll-smooth" data-content_root="./" lang="English" x-data="{ darkMode: localStorage.getItem('darkMode') || localStorage.setItem('darkMode', 'system'), activeSection: '' }" x-init="$watch('darkMode', val =&gt; localStorage.setItem('darkMode', val))">
<head>
<meta content="width=device-width, initial-scale=1.0" name="viewport"/>
<meta charset="utf-8"/>
<meta content="white" media="(prefers-color-scheme: light)" name="theme-color"/>
<meta content="black" media="(prefers-color-scheme: dark)" name="theme-color"/>
<meta content="width=device-width, initial-scale=1" name="viewport"/>
<title>Contributing | ISEK 0.1 documentation</title>
<meta content="Contributing | ISEK 0.1 documentation" property="og:title"/>
<meta content="Contributing | ISEK 0.1 documentation" name="twitter:title"/>
<link href="_static/pygments.css?v=e72c8e07" rel="stylesheet" type="text/css"/>
<link href="_static/theme.css?v=42baaae4" rel="stylesheet" type="text/css"/>
<link href="search.html" rel="search" title="Search"/>
<link href="genindex.html" rel="index" title="Index"/>
<link href="api/util.html" rel="prev" title="Util"/>
<script>
    <!-- Prevent Flash of wrong theme -->
      const userPreference = localStorage.getItem('darkMode');
      let mode;
      if (userPreference === 'dark' || window.matchMedia('(prefers-color-scheme: dark)').matches) {
        mode = 'dark';
        document.documentElement.classList.add('dark');
      } else {
        mode = 'light';
      }
      if (!userPreference) {localStorage.setItem('darkMode', mode)}
    </script>
</head>
<body :class="{ 'overflow-hidden': showSidebar }" class="min-h-screen font-sans antialiased bg-background text-foreground" x-data="{ showSidebar: false, showScrollTop: false }">
<div @click.self="showSidebar = false" class="fixed inset-0 z-50 overflow-hidden bg-background/80 backdrop-blur-sm md:hidden" x-cloak="" x-show="showSidebar"></div><div class="relative flex flex-col min-h-screen" id="page"><a class="absolute top-0 left-0 z-[100] block bg-background p-4 text-xl transition -translate-x-full opacity-0 focus:translate-x-0 focus:opacity-100" href="#content">
      Skip to content
    </a><header class="sticky top-0 z-40 w-full border-b shadow-sm border-border supports-backdrop-blur:bg-background/60 bg-background/95 backdrop-blur"><div class="container flex items-center h-14">
<div class="hidden mr-4 md:flex">
<a class="flex items-center mr-6" href="index.html"><span class="hidden font-bold sm:inline-block text-clip whitespace-nowrap">ISEK 0.1 documentation</span>
</a></div><button @click="showSidebar = true" class="inline-flex items-center justify-center h-10 px-0 py-2 mr-2 text-base font-medium transition-colors rounded-md hover:text-accent-foreground hover:bg-transparent md:hidden" type="button">
<svg aria-hidden="true" fill="currentColor" height="24" viewbox="0 96 960 960" width="24" xmlns="http://www.w3.org/2000/svg">
<path d="M152.587 825.087q-19.152 0-32.326-13.174t-13.174-32.326q0-19.152 13.174-32.326t32.326-13.174h440q19.152 0 32.326 13.174t13.174 32.326q0 19.152-13.174 32.326t-32.326 13.174h-440Zm0-203.587q-19.152 0-32.326-13.174T107.087 576q0-19.152 13.174-32.326t32.326-13.174h320q19.152 0 32.326 13.174T518.087 576q0 19.152-13.174 32.326T472.587 621.5h-320Zm0-203.587q-19.152 0-32.326-13.174t-13.174-32.326q0-19.152 13.174-32.326t32.326-13.174h440q19.152 0 32.326 13.174t13.174 32.326q0 19.152-13.174 32.326t-32.326 13.174h-440ZM708.913 576l112.174 112.174q12.674 12.674 12.674 31.826t-12.674 31.826Q808.413 764.5 789.261 764.5t-31.826-12.674l-144-144Q600 594.391 600 576t13.435-31.826l144-144q12.674-12.674 31.826-12.674t31.826 12.674q12.674 12.674 12.674 31.826t-12.674 31.826L708.913 576Z"></path>
</svg>
<span class="sr-only">Toggle navigation menu</span>
</button>
<div class="flex items-center justify-between flex-1 space-x-2 sm:space-x-4 md:justify-end">
<div class="flex-1 w-full md:w-auto md:flex-none"><form @keydown.k.window.meta="$refs.search.focus()" action="search.html" class="relative flex items-center group" id="searchbox" method="get">
<input aria-label="Search the docs" class="inline-flex items-center font-medium transition-colors bg-transparent focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring focus-visible:ring-offset-2 ring-offset-background border border-input hover:bg-accent focus:bg-accent hover:text-accent-foreground focus:text-accent-foreground hover:placeholder-accent-foreground py-2 px-4 relative h-9 w-full justify-start rounded-[0.5rem] text-sm text-muted-foreground sm:pr-12 md:w-40 lg:w-64" id="search-input" name="q" placeholder="Search ..." type="search" x-ref="search"/>
<kbd class="pointer-events-none absolute right-1.5 top-2 hidden h-5 select-none text-muted-foreground items-center gap-1 rounded border border-border bg-muted px-1.5 font-mono text-[10px] font-medium opacity-100 sm:flex group-hover:bg-accent group-hover:text-accent-foreground">
<span class="text-xs">⌘</span>
    K
  </kbd>
</form>
</div>
<nav class="flex items-center space-x-1">
<button @click="darkMode = darkMode === 'light' ? 'dark' : 'light'" aria-label="Color theme switcher" class="relative inline-flex items-center justify-center px-0 text-sm font-medium transition-colors rounded-md hover:bg-accent hover:text-accent-foreground h-9 w-9" type="button">
<svg class="absolute transition-all scale-100 rotate-0 dark:-rotate-90 dark:scale-0" fill="currentColor" height="24" viewbox="0 96 960 960" width="24" xmlns="http://www.w3.org/2000/svg">
<path d="M480 685q45.456 0 77.228-31.772Q589 621.456 589 576q0-45.456-31.772-77.228Q525.456 467 480 467q-45.456 0-77.228 31.772Q371 530.544 371 576q0 45.456 31.772 77.228Q434.544 685 480 685Zm0 91q-83 0-141.5-58.5T280 576q0-83 58.5-141.5T480 376q83 0 141.5 58.5T680 576q0 83-58.5 141.5T480 776ZM80 621.5q-19.152 0-32.326-13.174T34.5 576q0-19.152 13.174-32.326T80 530.5h80q19.152 0 32.326 13.174T205.5 576q0 19.152-13.174 32.326T160 621.5H80Zm720 0q-19.152 0-32.326-13.174T754.5 576q0-19.152 13.174-32.326T800 530.5h80q19.152 0 32.326 13.174T925.5 576q0 19.152-13.174 32.326T880 621.5h-80Zm-320-320q-19.152 0-32.326-13.174T434.5 256v-80q0-19.152 13.174-32.326T480 130.5q19.152 0 32.326 13.174T525.5 176v80q0 19.152-13.174 32.326T480 301.5Zm0 720q-19.152 0-32.326-13.17Q434.5 995.152 434.5 976v-80q0-19.152 13.174-32.326T480 850.5q19.152 0 32.326 13.174T525.5 896v80q0 19.152-13.174 32.33-13.174 13.17-32.326 13.17ZM222.174 382.065l-43-42Q165.5 327.391 166 308.239t13.174-33.065q13.435-13.674 32.587-13.674t32.065 13.674l42.239 43q12.674 13.435 12.555 31.706-.12 18.272-12.555 31.946-12.674 13.674-31.445 13.413-18.772-.261-32.446-13.174Zm494 494.761-42.239-43q-12.674-13.435-12.674-32.087t12.674-31.565Q686.609 756.5 705.38 757q18.772.5 32.446 13.174l43 41.761Q794.5 824.609 794 843.761t-13.174 33.065Q767.391 890.5 748.239 890.5t-32.065-13.674Zm-42-494.761Q660.5 369.391 661 350.62q.5-18.772 13.174-32.446l41.761-43Q728.609 261.5 747.761 262t33.065 13.174q13.674 13.435 13.674 32.587t-13.674 32.065l-43 42.239q-13.435 12.674-31.706 12.555-18.272-.12-31.946-12.555Zm-495 494.761Q165.5 863.391 165.5 844.239t13.674-32.065l43-42.239q13.435-12.674 32.087-12.674t31.565 12.674Q299.5 782.609 299 801.38q-.5 18.772-13.174 32.446l-41.761 43Q231.391 890.5 212.239 890t-33.065-13.174ZM480 576Z"></path>
</svg>
<svg class="absolute transition-all scale-0 rotate-90 dark:rotate-0 dark:scale-100" fill="currentColor" height="24" viewbox="0 96 960 960" width="24" xmlns="http://www.w3.org/2000/svg">
<path d="M480 936q-151 0-255.5-104.5T120 576q0-138 90-239.5T440 218q25-3 39 18t-1 44q-17 26-25.5 55t-8.5 61q0 90 63 153t153 63q31 0 61.5-9t54.5-25q21-14 43-1.5t19 39.5q-14 138-117.5 229T480 936Zm0-80q88 0 158-48.5T740 681q-20 5-40 8t-40 3q-123 0-209.5-86.5T364 396q0-20 3-40t8-40q-78 32-126.5 102T200 576q0 116 82 198t198 82Zm-10-270Z"></path>
</svg>
</button>
</nav>
</div>
</div>
</header>
<div class="flex-1"><div class="container flex-1 items-start md:grid md:grid-cols-[220px_minmax(0,1fr)] md:gap-6 lg:grid-cols-[240px_minmax(0,1fr)] lg:gap-10"><aside :aria-hidden="!showSidebar" :class="{ 'translate-x-0': showSidebar }" class="fixed inset-y-0 left-0 md:top-14 z-50 md:z-30 bg-background md:bg-transparent transition-all duration-100 -translate-x-full md:translate-x-0 ml-0 p-6 md:p-0 md:-ml-2 md:h-[calc(100vh-3.5rem)] w-5/6 md:w-full shrink-0 overflow-y-auto border-r border-border md:sticky" id="left-sidebar">
<a class="!justify-start text-sm md:!hidden bg-background" href="index.html"><span class="font-bold text-clip whitespace-nowrap">ISEK 0.1 documentation</span>
</a>
<div class="relative overflow-hidden md:overflow-auto my-4 md:my-0 h-[calc(100vh-8rem)] md:h-auto">
<div class="overflow-y-auto h-full w-full relative pr-6"><nav class="table w-full min-w-full my-6 lg:my-8">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quick Start</a></li>
<li class="toctree-l1" x-data="{ expanded: $el.classList.contains('current') ? true : false }"><a :class="{ 'expanded' : expanded }" @click="expanded = !expanded" class="reference internal expandable" href="user_guide/index.html">User Guide<button @click.prevent.stop="expanded = !expanded" type="button"><span class="sr-only"></span><svg fill="currentColor" height="18px" stroke="none" viewbox="0 0 24 24" width="18px" xmlns="http://www.w3.org/2000/svg"><path d="M10 6L8.59 7.41 13.17 12l-4.58 4.59L10 18l6-6z"></path></svg></button></a><ul x-show="expanded">
<li class="toctree-l2"><a class="reference internal" href="user_guide/concepts.html">Concepts</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_guide/agents.html">Agents</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_guide/configuration.html">Configuration</a></li>
</ul>
</li>
<li class="toctree-l1" x-data="{ expanded: $el.classList.contains('current') ? true : false }"><a :class="{ 'expanded' : expanded }" @click="expanded = !expanded" class="reference internal expandable" href="api/index.html">API Reference<button @click.prevent.stop="expanded = !expanded" type="button"><span class="sr-only"></span><svg fill="currentColor" height="18px" stroke="none" viewbox="0 0 24 24" width="18px" xmlns="http://www.w3.org/2000/svg"><path d="M10 6L8.59 7.41 13.17 12l-4.58 4.59L10 18l6-6z"></path></svg></button></a><ul x-show="expanded">
<li class="toctree-l2"><a class="reference internal" href="api/core.html">Core Components</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/agent.html">Agent Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/llm.html">Large Language Model</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/embedding.html">Embedding</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/node.html">Node</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/util.html">Util</a></li>
</ul>
</li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Contributing</a></li>
</ul>
</nav>
</div>
</div>
<button @click="showSidebar = false" class="absolute md:hidden right-4 top-4 rounded-sm opacity-70 transition-opacity hover:opacity-100" type="button">
<svg class="h-4 w-4" fill="currentColor" height="24" stroke="none" viewbox="0 96 960 960" width="24" xmlns="http://www.w3.org/2000/svg">
<path d="M480 632 284 828q-11 11-28 11t-28-11q-11-11-11-28t11-28l196-196-196-196q-11-11-11-28t11-28q11-11 28-11t28 11l196 196 196-196q11-11 28-11t28 11q11 11 11 28t-11 28L536 576l196 196q11 11 11 28t-11 28q-11 11-28 11t-28-11L480 632Z"></path>
</svg>
</button>
</aside>
<main class="relative py-6 lg:gap-10 lg:py-8 xl:grid xl:grid-cols-[1fr_300px]">
<div class="w-full min-w-0 mx-auto">
<nav aria-label="breadcrumbs" class="flex items-center mb-4 space-x-1 text-sm text-muted-foreground">
<a class="overflow-hidden text-ellipsis whitespace-nowrap hover:text-foreground" href="index.html">
<span class="hidden md:inline">ISEK 0.1 documentation</span>
<svg aria-label="Home" class="md:hidden" fill="currentColor" height="18" stroke="none" viewbox="0 96 960 960" width="18" xmlns="http://www.w3.org/2000/svg">
<path d="M240 856h120V616h240v240h120V496L480 316 240 496v360Zm-80 80V456l320-240 320 240v480H520V696h-80v240H160Zm320-350Z"></path>
</svg>
</a>
<div class="mr-1">/</div><span aria-current="page" class="font-medium text-foreground overflow-hidden text-ellipsis whitespace-nowrap">Contributing</span>
</nav>
<div id="content" role="main">
<section id="contributing">
<h1>Contributing<a class="headerlink" href="#contributing" title="Link to this heading"><span>#</span></a></h1>
<p>Thank you for considering contributing to ISEK! We're thrilled you're interested in making ISEK better. ISEK is an open-source project, and we welcome contributions of all kinds, from bug fixes to new features and documentation improvements.</p>
<section id="ways-to-contribute">
<h2>Ways to Contribute<a class="headerlink" href="#ways-to-contribute" title="Link to this heading" x-intersect.margin.0%.0%.-70%.0%="activeSection = '#ways-to-contribute'"><span>#</span></a></h2>
<ul class="simple">
<li><p><strong>Reporting Bugs:</strong> If you find a bug, please open an issue on GitHub. Include as much detail as possible: steps to reproduce, expected behavior, actual behavior, and your environment.</p></li>
<li><p><strong>Suggesting Enhancements:</strong> Have an idea for a new feature or an improvement to an existing one? Open an issue to discuss it.</p></li>
<li><p><strong>Code Contributions:</strong> Fixing bugs, implementing new features, or improving existing code.</p></li>
<li><p><strong>Documentation:</strong> Improving our README, adding examples, or writing more detailed documentation.</p></li>
<li><p><strong>Community Support:</strong> Helping answer questions in issues or other community channels (if applicable).</p></li>
</ul>
</section>
<section id="getting-started-your-first-contribution">
<h2>Getting Started: Your First Contribution<a class="headerlink" href="#getting-started-your-first-contribution" title="Link to this heading" x-intersect.margin.0%.0%.-70%.0%="activeSection = '#getting-started-your-first-contribution'"><span>#</span></a></h2>
<p>Unsure where to begin? You can start by looking through <code class="docutils literal notranslate"><span class="pre">`good</span> <span class="pre">first</span> <span class="pre">issue`</span></code> or <code class="docutils literal notranslate"><span class="pre">`help</span> <span class="pre">wanted`</span></code> issues in our repository.</p>
<p>If you're ready to contribute code, here's how to set up ISEK for local development:</p>
<ol class="arabic">
<li><p><strong>Fork the Repository:</strong>
Click the "Fork" button at the top right of the <a class="reference external" href="https://github.com/your_org_or_username/isek">ISEK GitHub page</a> (replace with the actual ISEK project repository URL). This creates your own copy of the project.</p></li>
<li><p><strong>Clone Your Fork:</strong></p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><code><span id="line-1">git<span class="w"> </span>clone<span class="w"> </span>https://github.com/YOUR_GITHUB_USERNAME/isek.git
</span><span id="line-2"><span class="nb">cd</span><span class="w"> </span>isek
</span></code></pre></div>
</div>
<p>Replace <code class="docutils literal notranslate"><span class="pre">YOUR_GITHUB_USERNAME</span></code> with your GitHub username.</p>
</li>
<li><p><strong>Set Up a Virtual Environment:</strong>
We recommend using a virtual environment to manage dependencies.</p>
<ul>
<li><p><strong>Using ``venv`` (standard Python):</strong></p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><code><span id="line-1">python<span class="w"> </span>-m<span class="w"> </span>venv<span class="w"> </span>.venv
</span><span id="line-2"><span class="nb">source</span><span class="w"> </span>.venv/bin/activate<span class="w">  </span><span class="c1"># On Windows: .venv\Scripts\activate</span>
</span></code></pre></div>
</div>
</li>
<li><p><strong>Using Hatch (if your project is set up with it):</strong>
Hatch will manage virtual environments for you.</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><code><span id="line-1">hatch<span class="w"> </span>env<span class="w"> </span>create
</span><span id="line-2">hatch<span class="w"> </span>shell<span class="w"> </span><span class="c1"># To activate the environment managed by Hatch</span>
</span></code></pre></div>
</div>
</li>
</ul>
</li>
<li><p><strong>Install Dependencies:</strong></p>
<ul>
<li><p><strong>If using ``venv`` and you have a ``requirements-dev.txt`` or similar:</strong></p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><code><span id="line-1">pip<span class="w"> </span>install<span class="w"> </span>-r<span class="w"> </span>requirements-dev.txt<span class="w"> </span><span class="c1"># Or just requirements.txt</span>
</span><span id="line-2">pip<span class="w"> </span>install<span class="w"> </span>-e<span class="w"> </span>.<span class="w"> </span><span class="c1"># Install ISEK in editable mode</span>
</span></code></pre></div>
</div>
</li>
<li><p><strong>If using Hatch:</strong>
Hatch usually installs dependencies when creating the environment. If you have specific dependency groups (e.g., <code class="docutils literal notranslate"><span class="pre">dev</span></code>, <code class="docutils literal notranslate"><span class="pre">test</span></code>), they might be installed automatically or you can install them with:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><code><span id="line-1">hatch<span class="w"> </span>dep<span class="w"> </span>install<span class="w"> </span>dev<span class="w"> </span><span class="nb">test</span><span class="w"> </span><span class="c1"># Example, adjust as needed</span>
</span></code></pre></div>
</div>
<p>The project itself is usually installed in editable mode automatically by Hatch.</p>
</li>
</ul>
</li>
<li><p><strong>Install Pre-commit Hooks:</strong>
We use <code class="docutils literal notranslate"><span class="pre">pre-commit</span></code> to ensure code style and quality before committing.</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><code><span id="line-1">pip<span class="w"> </span>install<span class="w"> </span>pre-commit<span class="w"> </span><span class="c1"># If not already installed via dev dependencies</span>
</span><span id="line-2">pre-commit<span class="w"> </span>install
</span></code></pre></div>
</div>
<p>This will run checks automatically every time you commit. You can also run them manually:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><code><span id="line-1">pre-commit<span class="w"> </span>run<span class="w"> </span>--all-files
</span></code></pre></div>
</div>
</li>
</ol>
</section>
<section id="making-changes">
<h2>Making Changes<a class="headerlink" href="#making-changes" title="Link to this heading" x-intersect.margin.0%.0%.-70%.0%="activeSection = '#making-changes'"><span>#</span></a></h2>
<ol class="arabic">
<li><p><strong>Create a New Branch:</strong>
Create a branch from the <code class="docutils literal notranslate"><span class="pre">main</span></code> (or <code class="docutils literal notranslate"><span class="pre">develop</span></code>, whichever is your primary development branch) for your feature or bug fix. Use a descriptive name.</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><code><span id="line-1">git<span class="w"> </span>checkout<span class="w"> </span>main<span class="w"> </span><span class="c1"># Or develop</span>
</span><span id="line-2">git<span class="w"> </span>pull<span class="w"> </span>upstream<span class="w"> </span>main<span class="w"> </span><span class="c1"># Ensure you have the latest changes from the main repository</span>
</span><span id="line-3">git<span class="w"> </span>checkout<span class="w"> </span>-b<span class="w"> </span>feat/your-descriptive-feature-name<span class="w">  </span><span class="c1"># For a new feature</span>
</span><span id="line-4"><span class="c1"># or</span>
</span><span id="line-5">git<span class="w"> </span>checkout<span class="w"> </span>-b<span class="w"> </span>fix/issue-number-short-description<span class="w"> </span><span class="c1"># For a bug fix</span>
</span></code></pre></div>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The <code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">pull</span> <span class="pre">upstream</span> <span class="pre">main</span></code> command assumes you've set up <code class="docutils literal notranslate"><span class="pre">upstream</span></code> to point to the original ISEK repository (e.g., <code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">remote</span> <span class="pre">add</span> <span class="pre">upstream</span> <span class="pre">https://github.com/your_org_or_username/isek.git</span></code> - replace with the actual ISEK project repository URL).</p>
</div>
</li>
<li><p><strong>Add Your Feature or Improvement:</strong>
Write your code! Make sure to:</p>
<ul class="simple">
<li><p>Follow the existing code style.</p></li>
<li><p>Add tests for any new functionality or bug fixes.</p></li>
<li><p>Update documentation if you're changing behavior or adding features.</p></li>
</ul>
</li>
<li><p><strong>Run Pre-commit Checks:</strong>
Before you commit, ensure <code class="docutils literal notranslate"><span class="pre">pre-commit</span></code> checks pass. If you installed the hooks, they will run automatically on <code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">commit</span></code>. If they fail, address the issues and try committing again.</p></li>
<li><p><strong>Run Tests:</strong>
Ensure all tests pass.</p>
<ul>
<li><p><strong>If using ``pytest`` directly:</strong></p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><code><span id="line-1">pytest
</span></code></pre></div>
</div>
</li>
<li><p><strong>If using Hatch (assuming a ``test`` script is defined in ``pyproject.toml``):</strong></p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><code><span id="line-1">hatch<span class="w"> </span>run<span class="w"> </span><span class="nb">test</span>
</span><span id="line-2"><span class="c1"># or for coverage</span>
</span><span id="line-3">hatch<span class="w"> </span>run<span class="w"> </span>test:cov
</span></code></pre></div>
</div>
</li>
</ul>
</li>
<li><p><strong>Commit Your Changes:</strong>
Use clear and concise commit messages. If your changes address a specific issue, reference it in your commit message (e.g., <code class="docutils literal notranslate"><span class="pre">Fixes</span> <span class="pre">#123</span></code>).</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><code><span id="line-1">git<span class="w"> </span>add<span class="w"> </span>.
</span><span id="line-2">git<span class="w"> </span>commit<span class="w"> </span>-m<span class="w"> </span><span class="s2">"feat: Add X functionality to Y module"</span>
</span></code></pre></div>
</div>
</li>
<li><p><strong>Push to Your Fork:</strong></p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><code><span id="line-1">git<span class="w"> </span>push<span class="w"> </span>origin<span class="w"> </span>feat/your-descriptive-feature-name
</span></code></pre></div>
</div>
</li>
</ol>
</section>
<section id="submitting-a-pull-request-pr">
<h2>Submitting a Pull Request (PR)<a class="headerlink" href="#submitting-a-pull-request-pr" title="Link to this heading" x-intersect.margin.0%.0%.-70%.0%="activeSection = '#submitting-a-pull-request-pr'"><span>#</span></a></h2>
<ol class="arabic simple">
<li><p>Go to the ISEK repository on GitHub. You should see a prompt to create a Pull Request from your recently pushed branch.</p></li>
<li><p>Click "Compare &amp; pull request".</p></li>
<li><p>Ensure the base repository is <code class="docutils literal notranslate"><span class="pre">your_org_or_username/isek</span></code> (replace with actual) and the base branch is <code class="docutils literal notranslate"><span class="pre">main</span></code> (or <code class="docutils literal notranslate"><span class="pre">develop</span></code>).</p></li>
<li><p>Provide a clear title and a detailed description for your PR:</p>
<ul class="simple">
<li><p><strong>Title:</strong> A brief summary of the changes (e.g., "Feat: Add support for Z").</p></li>
<li><p><strong>Description:</strong> Explain the "what" and "why" of your changes. If it fixes an issue, link to it (e.g., "Closes #123"). Include any relevant context or screenshots.</p></li>
</ul>
</li>
<li><p>Click "Create pull request."</p></li>
</ol>
</section>
<section id="pull-request-review-process">
<h2>Pull Request Review Process<a class="headerlink" href="#pull-request-review-process" title="Link to this heading" x-intersect.margin.0%.0%.-70%.0%="activeSection = '#pull-request-review-process'"><span>#</span></a></h2>
<ul class="simple">
<li><p>Once your PR is submitted, project maintainers or assigned community members will review it.</p></li>
<li><p>We may ask for changes or clarifications. Please be responsive to feedback.</p></li>
<li><p>Once the PR is approved and all checks pass, it will be merged.</p></li>
</ul>
<p>We appreciate your patience during the review process!</p>
</section>
<section id="code-style">
<h2>Code Style<a class="headerlink" href="#code-style" title="Link to this heading" x-intersect.margin.0%.0%.-70%.0%="activeSection = '#code-style'"><span>#</span></a></h2>
<p>We use tools like Black for code formatting and Ruff/Flake8 for linting, managed via <code class="docutils literal notranslate"><span class="pre">pre-commit</span></code>. Please ensure your contributions adhere to these standards by running <code class="docutils literal notranslate"><span class="pre">pre-commit</span></code> before submitting your PR.</p>
</section>
<section id="questions">
<h2>Questions?<a class="headerlink" href="#questions" title="Link to this heading" x-intersect.margin.0%.0%.-70%.0%="activeSection = '#questions'"><span>#</span></a></h2>
<p>If you have questions or need help, feel free to open an issue with the <code class="docutils literal notranslate"><span class="pre">question</span></code> label, or reach out on our community channels (e.g., Discord, Slack - list them here if applicable).</p>
<p>Thank you for contributing to ISEK!</p>
</section>
</section>
</div></div><aside class="hidden text-sm xl:block" id="right-sidebar">
<div class="sticky top-16 -mt-10 max-h-[calc(100vh-5rem)] overflow-y-auto pt-6 space-y-2"><p class="font-medium">On this page</p>
<ul>
<li><a :data-current="activeSection === '#ways-to-contribute'" class="reference internal" href="#ways-to-contribute">Ways to Contribute</a></li>
<li><a :data-current="activeSection === '#getting-started-your-first-contribution'" class="reference internal" href="#getting-started-your-first-contribution">Getting Started: Your First Contribution</a></li>
<li><a :data-current="activeSection === '#making-changes'" class="reference internal" href="#making-changes">Making Changes</a></li>
<li><a :data-current="activeSection === '#submitting-a-pull-request-pr'" class="reference internal" href="#submitting-a-pull-request-pr">Submitting a Pull Request (PR)</a></li>
<li><a :data-current="activeSection === '#pull-request-review-process'" class="reference internal" href="#pull-request-review-process">Pull Request Review Process</a></li>
<li><a :data-current="activeSection === '#code-style'" class="reference internal" href="#code-style">Code Style</a></li>
<li><a :data-current="activeSection === '#questions'" class="reference internal" href="#questions">Questions?</a></li>
</ul>
</div>
</aside>
</main>
</div>
</div><footer class="py-6 border-t border-border md:py-0">
<div class="container flex flex-col items-center justify-between gap-4 md:h-24 md:flex-row">
<div class="flex flex-col items-center gap-4 px-8 md:flex-row md:gap-2 md:px-0">
<p class="text-sm leading-loose text-center text-muted-foreground md:text-left">© 2025, ISEK Team Built with <a class="font-medium underline underline-offset-4" href="https://www.sphinx-doc.org" rel="noreferrer">Sphinx 8.1.3</a></p>
</div>
</div>
</footer>
</div>
<script src="_static/documentation_options.js?v=2ed17a75"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script defer="defer" src="_static/theme.js?v=073f68d9"></script>
</body>
</html>